Skip to content

docs(contributor): verify developer startup and token guidelines - #430

Merged
Qiyuanqiii merged 1 commit into
CWNU-Open-Source-Community:mainfrom
NanaseInori:fix/docs-startup-downloads
Oct 28, 2026
Merged

Qiyuanqiii merged 1 commit into
CWNU-Open-Source-Community:mainfrom
NanaseInori:fix/docs-startup-downloads

Conversation

@NanaseInori

@NanaseInori NanaseInori commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Copying the old CONTRIBUTING examples sets 16- and 19-byte tokens, so the API rejects startup (minimum: 32 bytes). This PR updates the contributor startup documentation and adds automated verification:

  • Generate separate read and control tokens from 32 cryptographically random bytes using Node.js for both Linux/macOS (Bash) and Windows (PowerShell 5.1).
  • Document isolated development storage in .cyberagent-workbench/dev\ to prevent interfering with the desktop app data directory.
  • Detail the two-terminal workflow: running Go API on \127.0.0.1:8765\ and Vite frontend proxy on \127.0.0.1:5173.
  • Add \scripts/check-contributor-startup.mjs\ to execute documented shell commands against real Go and Vite processes, verifying authentication, token separation, and headless Chromium connection.
  • Add .github/workflows/documentation.yml\ to run contributor startup verification across Ubuntu and Windows in CI.

(Note: Public download guides, release documentation, and desktop packaging triggers originally in this PR have been decoupled into PR #514).

Validation

  • Local test:
    ode scripts/check-contributor-startup.mjs\ passed on Windows PowerShell 5.1 (Go API, Vite proxy, token boundary, and Chromium connection verified).
  • GitHub Actions documentation check 40666938703: passed on both \ubuntu-latest\ and \windows-latest.
  • Full central CI 40666938652: all jobs passed.
  • Authored by \Gemini gemini-code-assist@users.noreply.github.com.

@NanaseInori NanaseInori changed the title fix(docs): verify contributor startup and current release downloads fix: verify startup and download docs and resolve CI failures Oct 21, 2026
Update contributor documentation and add automated startup validation:
- Document crypto-random 32-byte API tokens generated via Node.js for both Bash and PowerShell.
- Document isolated development storage in .cyberagent-workbench/dev.
- Detail the two-terminal workflow (Go backend and Vite frontend proxy to 127.0.0.1:8765).
- Add scripts/check-contributor-startup.mjs to execute documented snippets and verify token separation and Chromium browser connection.
- Add GitHub Actions documentation check workflow for contributor startup on Ubuntu and Windows.

Validation:
- node scripts/check-contributor-startup.mjs executed and passed with Go API, Vite proxy and Chromium connection.
@Qiyuanqiii
Qiyuanqiii force-pushed the fix/docs-startup-downloads branch from 168a2dc to 7aee73e Compare October 28, 2026 09:46
@Qiyuanqiii Qiyuanqiii changed the title fix: verify startup and download docs and resolve CI failures docs(contributor): verify developer startup and token guidelines Oct 28, 2026
@Qiyuanqiii

Copy link
Copy Markdown
Member

Scope decoupling update

按规范将原 PR 中混杂的「启动文档/自检」与「发行下载指南/打包工作流」解耦:

  • 本 PR(docs(contributor): verify developer startup and token guidelines #430)瘦身聚焦:贡献者启动文档(CONTRIBUTING.md)、32 字节 Token 规范、自动化启动与浏览器连接自检脚本(scripts/check-contributor-startup.mjs)及文档 CI。
  • 解耦部分:公开发布下载指南对齐(README 与平台 Release 说明、check-download-docs.py)及 release-desktop.yml 打包工作流白名单调整,已移入独立 PR 处理。
  • 合入重叠核对:此前 PR 附带的 DOMPurify 3.4.17 补丁与 Vitest/undici 修复已在 fix(deps): reuse Monaco sanitizer fix and patch Vitest/undici #501 中合入,本 PR 已基于最新 main 完成干净 rebase 并剔除重叠内容。

@Qiyuanqiii
Qiyuanqiii merged commit c76fefa into CWNU-Open-Source-Community:main Oct 28, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants